All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.java.accessibility.AccessibleText

public interface AccessibleText

The AccessibleText interface should be implemented by all classes that present textual information on the display. This interface provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. Applications can determine if an object supports the AccessibleText interface by first obtaining its AccessibleContext (see Accessible) and then calling the getAccessibleText method of AccessibleContext. If the return value is not null, the object supports this interface.

See Also:

Accessible, getAccessibleContext, AccessibleContext, getAccessibleText

CHARACTER

Constant used to indicate that the part of text that should be retrieved is a character.

SENTENCE

Constant used to indicate that the part of text that should be retrieved is a sentence.

WORD

Constant used to indicate that the part of text that should be retrieved is a word.

getAfterIndex(int, int)

Return the String after a given index.

getAtIndex(int, int)

Return the String at a given index.

getBeforeIndex(int, int)

Return the String before a given index.

getCaretPosition()

Return the zero-based offset of the caret.

getCharacterAttribute(int)

Return the AttributeSet for a given character at a given index

getCharacterBounds(int)

Determine the bounding box of the character at the given index into the string.

getCharCount()

Return the number of characters (valid indicies)

getIndexAtPoint(Point)

Given a point in local coordinates, return the zero-based index of the character under that Point.

getSelectedText()

Returns the portion of the text that is selected.

getSelectionEnd()

Returns the end offset within the selected text.

getSelectionStart()

Returns the start offset within the selected text.

 public static final int CHARACTER

Constant used to indicate that the part of text that should be retrieved is a character.

See Also:

getAtIndex, getAfterIndex, getBeforeIndex

 public static final int WORD

Constant used to indicate that the part of text that should be retrieved is a word.

See Also:

getAtIndex, getAfterIndex, getBeforeIndex

 public static final int SENTENCE

Constant used to indicate that the part of text that should be retrieved is a sentence.

See Also:

getAtIndex, getAfterIndex, getBeforeIndex

 public abstract int getIndexAtPoint(Point p)

Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Parameters:

p - the Point in local coordinates

Returns:

the zero-based index of the character under Point p; if Point is invalid returns -1.

 public abstract Rectangle getCharacterBounds(int i)

Determine the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.

Parameters:

i - the index into the String

Returns:

the screen coordinates of the character's the bounding box, if index is invalid returns an empty rectangle.

 public abstract int getCharCount()

Return the number of characters (valid indicies)

Returns:

the number of characters

 public abstract int getCaretPosition()

Return the zero-based offset of the caret. Note: That to the right of the caret will have the same index value as the offset (the caret is between two characters).

Returns:

the zero-based offset of the caret.

 public abstract String getAtIndex(int part,
                                   int index)

Return the String at a given index.

Parameters:

part - the CHARACTER, WORD, or SENTENCE to retrieve

index - an index within the text

Returns:

the letter, word, or sentence

 public abstract String getAfterIndex(int part,
                                      int index)

Return the String after a given index.

Parameters:

part - the CHARACTER, WORD, or SENTENCE to retrieve

index - an index within the text

Returns:

the letter, word, or sentence

 public abstract String getBeforeIndex(int part,
                                       int index)

Return the String before a given index.

Parameters:

part - the CHARACTER, WORD, or SENTENCE to retrieve

index - an index within the text

Returns:

the letter, word, or sentence

 public abstract AttributeSet getCharacterAttribute(int i)

Return the AttributeSet for a given character at a given index

Parameters:

i - the zero-based index into the text

Returns:

the AttributeSet of the character

 public abstract int getSelectionStart()

Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns:

the index into the text of the start of the selection

 public abstract int getSelectionEnd()

Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns:

the index into teh text of the end of the selection

 public abstract String getSelectedText()

Returns the portion of the text that is selected.

Returns:

the String portion of the text that is selected

All Packages  Class Hierarchy  This Package  Previous  Next  Index